Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
F01FieldMessenger Class Reference
field » field01

#include <Doxymodules_field.h>

Inheritance diagram for F01FieldMessenger:
G4UImessenger

Public Member Functions

 F01FieldMessenger (F01FieldSetup *)
 
 ~F01FieldMessenger () override
 
void SetNewValue (G4UIcommand *, G4String) override
 

Private Attributes

F01FieldSetup * fEMfieldSetup = nullptr
 
G4UIdirectory * fFieldDir = nullptr
 
G4UIcmdWithAnInteger * fStepperCmd = nullptr
 
G4UIcmdWithADoubleAndUnit * fMagFieldZCmd = nullptr
 
G4UIcmdWith3VectorAndUnit * fMagFieldCmd = nullptr
 
G4UIcmdWithADoubleAndUnit * fMinStepCmd = nullptr
 
G4UIcmdWithADoubleAndUnit * fDeltaOneStepCmd = nullptr
 
G4UIcmdWithADouble * fEpsMinCmd = nullptr
 
G4UIcmdWithADouble * fEpsMaxCmd = nullptr
 
G4UIcmdWithoutParameter * fUpdateCmd = nullptr
 

Detailed Description

Definition at line 39 of file Doxymodules_field.h.

Constructor & Destructor Documentation

◆ F01FieldMessenger()

F01FieldMessenger::F01FieldMessenger ( F01FieldSetup *  fieldSetup)

Definition at line 48 of file F01FieldMessenger.cc.

49 : fEMfieldSetup(fieldSetup)
50{
51 fFieldDir = new G4UIdirectory("/field/");
52 fFieldDir->SetGuidance("F01 field tracking control.");
53
54 fStepperCmd = new G4UIcmdWithAnInteger("/field/setStepperType",this);
55 fStepperCmd->SetGuidance("Select stepper type for magnetic field");
56 fStepperCmd->SetParameterName("choice",true);
57 fStepperCmd->SetDefaultValue(4);
58 fStepperCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
59
60 fUpdateCmd = new G4UIcmdWithoutParameter("/field/update",this);
61 fUpdateCmd->SetGuidance("Update calorimeter geometry.");
62 fUpdateCmd->SetGuidance("This command MUST be applied before \"beamOn\" ");
63 fUpdateCmd->SetGuidance("if you changed geometrical value(s).");
64 fUpdateCmd->AvailableForStates(G4State_Idle);
65
66 fMagFieldZCmd = new G4UIcmdWithADoubleAndUnit("/field/setFieldZ",this);
67 fMagFieldZCmd->SetGuidance("Define magnetic field.");
68 fMagFieldZCmd->SetGuidance("Magnetic field will be in Z direction.");
69 fMagFieldZCmd->SetParameterName("Bz",false,false);
70 fMagFieldZCmd->SetDefaultUnit("tesla");
71 fMagFieldZCmd->AvailableForStates(G4State_Idle);
72
73 fMagFieldCmd = new G4UIcmdWith3VectorAndUnit("/field/setField",this);
74 fMagFieldCmd->SetGuidance("Define magnetic field.");
75 fMagFieldCmd->SetParameterName("Bx", "By", "Bz" ,false,false);
76 fMagFieldCmd->SetDefaultUnit("tesla");
77 fMagFieldCmd->AvailableForStates(G4State_Idle);
78
79 fMinStepCmd = new G4UIcmdWithADoubleAndUnit("/field/setMinStep",this);
80 fMinStepCmd->SetGuidance("Define minimal step");
81 fMinStepCmd->SetGuidance("Magnetic field will be in Z direction.");
82 fMinStepCmd->SetParameterName("minStep",false,false);
83 fMinStepCmd->SetDefaultUnit("mm");
84 fMinStepCmd->AvailableForStates(G4State_Idle);
85
86 // Commands for integration accuracy
87 // 1. Delta One Step = length of potential error in each integration substep
88 // Recall that there can be up to 300 substeps in a physics step !!
89 fDeltaOneStepCmd = new G4UIcmdWithADoubleAndUnit("/field/setDeltaOneStep",this);
90 fDeltaOneStepCmd->SetGuidance("Define minimal step");
91 fDeltaOneStepCmd->SetGuidance("Magnetic field will be in Z direction.");
92 fDeltaOneStepCmd->SetParameterName("minStep",false,false);
93 fDeltaOneStepCmd->SetDefaultUnit("mm");
94 fDeltaOneStepCmd->AvailableForStates(G4State_Idle);
95
96 // A choice: Allow the user to reset the Eps Min/Max values to our default
97 G4bool omitable= true, currentAsDefault= false;
98 fEpsMinCmd = new G4UIcmdWithADouble("/field/setEpsilonMin",this);
99 fEpsMinCmd->SetGuidance(
100 "Define minimum value of the relative integration error (EpsilonMin)"
101 " - a dimensionless number\n"
102 "Limit to ensure that large steps do NOT result in a very low value"
103 "(ie high accuracy) that integration needs many steps and CPU cycles.");
104 fEpsMinCmd->SetParameterName("minEpsilon",omitable,currentAsDefault);
105 fEpsMinCmd->SetDefaultValue(1.0e-4); // A default eps_min
106 fEpsMinCmd->AvailableForStates(G4State_Idle);
107
108 fEpsMaxCmd = new G4UIcmdWithADouble("/field/setEpsilonMax",this);
109 fEpsMaxCmd->SetGuidance(
110 "Define minimum value of the relative integration error (EpsilonMax)"
111 " - a dimensionless number\n"
112 "Limit to ensure a very small step does NOT result in a large relative"
113 " error (ie low accuracy) with unreliable results.");
114 fEpsMaxCmd->SetParameterName("maxEpsilon",omitable,currentAsDefault);
115 fEpsMinCmd->SetDefaultValue(1.0e-5); // A default eps_max
116 fEpsMaxCmd->AvailableForStates(G4State_Idle);
117
118 // HOW to Ensure that its value is val < G4FieldManager::GetMaxAcceptedEpsilon() ??
119
120}
F01FieldMessenger::fMinStepCmd
G4UIcmdWithADoubleAndUnit * fMinStepCmd
Definition F01FieldMessenger.hh:69
F01FieldMessenger::fDeltaOneStepCmd
G4UIcmdWithADoubleAndUnit * fDeltaOneStepCmd
Definition F01FieldMessenger.hh:70
F01FieldMessenger::fStepperCmd
G4UIcmdWithAnInteger * fStepperCmd
Definition F01FieldMessenger.hh:66
F01FieldMessenger::fMagFieldZCmd
G4UIcmdWithADoubleAndUnit * fMagFieldZCmd
Definition F01FieldMessenger.hh:67
F01FieldMessenger::fUpdateCmd
G4UIcmdWithoutParameter * fUpdateCmd
Definition F01FieldMessenger.hh:73
F01FieldMessenger::fEMfieldSetup
F01FieldSetup * fEMfieldSetup
Definition F01FieldMessenger.hh:62
F01FieldMessenger::fEpsMinCmd
G4UIcmdWithADouble * fEpsMinCmd
Definition F01FieldMessenger.hh:71
F01FieldMessenger::fEpsMaxCmd
G4UIcmdWithADouble * fEpsMaxCmd
Definition F01FieldMessenger.hh:72
F01FieldMessenger::fFieldDir
G4UIdirectory * fFieldDir
Definition F01FieldMessenger.hh:64
F01FieldMessenger::fMagFieldCmd
G4UIcmdWith3VectorAndUnit * fMagFieldCmd
Definition F01FieldMessenger.hh:68

◆ ~F01FieldMessenger()

F01FieldMessenger::~F01FieldMessenger ( )
override

Definition at line 124 of file F01FieldMessenger.cc.

125{
126 delete fStepperCmd;
127 delete fMagFieldZCmd;
128 delete fMagFieldCmd;
129 delete fMinStepCmd;
130 delete fDeltaOneStepCmd;
131 delete fEpsMinCmd;
132 delete fEpsMaxCmd;
133 delete fFieldDir;
134 delete fUpdateCmd;
135}

Member Function Documentation

◆ SetNewValue()

void F01FieldMessenger::SetNewValue ( G4UIcommand *  command,
G4String  newValue 
)
override

Definition at line 139 of file F01FieldMessenger.cc.

140{
141 if( command == fStepperCmd )
142 fEMfieldSetup->SetStepperType(fStepperCmd->GetNewIntValue(newValue));
143 if( command == fUpdateCmd )
144 fEMfieldSetup->CreateStepperAndChordFinder();
145 if( command == fMagFieldZCmd )
146 fEMfieldSetup->SetFieldZValue(fMagFieldZCmd->GetNewDoubleValue(newValue));
147 if( command == fMagFieldCmd )
148 fEMfieldSetup->SetFieldValue(fMagFieldCmd->GetNew3VectorValue(newValue));
149 if( command == fMinStepCmd )
150 fEMfieldSetup->SetMinStep(fMinStepCmd->GetNewDoubleValue(newValue));
151 if( command == fDeltaOneStepCmd )
152 fEMfieldSetup->SetDeltaOneStep(fDeltaOneStepCmd->GetNewDoubleValue(newValue));
153 if( command == fEpsMinCmd )
154 fEMfieldSetup->SetEpsilonMin(fEpsMinCmd->GetNewDoubleValue(newValue));
155 if( command == fEpsMaxCmd )
156 fEMfieldSetup->SetEpsilonMax(fEpsMaxCmd->GetNewDoubleValue(newValue));
157}
F01FieldSetup::SetMinStep
void SetMinStep(G4double s)
Definition F01FieldSetup.hh:74
F01FieldSetup::CreateStepperAndChordFinder
void CreateStepperAndChordFinder()
Definition F01FieldSetup.cc:216
F01FieldSetup::SetFieldZValue
void SetFieldZValue(G4double fieldValue)
Definition F01FieldSetup.cc:447
F01FieldSetup::SetStepperType
void SetStepperType(G4int i)
Definition F01FieldSetup.hh:69
F01FieldSetup::SetEpsilonMax
void SetEpsilonMax(G4double val)
Definition F01FieldSetup.hh:96
F01FieldSetup::SetDeltaOneStep
void SetDeltaOneStep(G4double val)
Definition F01FieldSetup.hh:98
F01FieldSetup::SetFieldValue
void SetFieldValue(G4ThreeVector fieldVector)
Definition F01FieldSetup.cc:456
F01FieldSetup::SetEpsilonMin
void SetEpsilonMin(G4double val)
Definition F01FieldSetup.hh:95

Member Data Documentation

◆ fEMfieldSetup

F01FieldSetup* F01FieldMessenger::fEMfieldSetup = nullptr
private

Definition at line 62 of file F01FieldMessenger.hh.

◆ fFieldDir

G4UIdirectory* F01FieldMessenger::fFieldDir = nullptr
private

Definition at line 64 of file F01FieldMessenger.hh.

◆ fStepperCmd

G4UIcmdWithAnInteger* F01FieldMessenger::fStepperCmd = nullptr
private

Definition at line 66 of file F01FieldMessenger.hh.

◆ fMagFieldZCmd

G4UIcmdWithADoubleAndUnit* F01FieldMessenger::fMagFieldZCmd = nullptr
private

Definition at line 67 of file F01FieldMessenger.hh.

◆ fMagFieldCmd

G4UIcmdWith3VectorAndUnit* F01FieldMessenger::fMagFieldCmd = nullptr
private

Definition at line 68 of file F01FieldMessenger.hh.

◆ fMinStepCmd

G4UIcmdWithADoubleAndUnit* F01FieldMessenger::fMinStepCmd = nullptr
private

Definition at line 69 of file F01FieldMessenger.hh.

◆ fDeltaOneStepCmd

G4UIcmdWithADoubleAndUnit* F01FieldMessenger::fDeltaOneStepCmd = nullptr
private

Definition at line 70 of file F01FieldMessenger.hh.

◆ fEpsMinCmd

G4UIcmdWithADouble* F01FieldMessenger::fEpsMinCmd = nullptr
private

Definition at line 71 of file F01FieldMessenger.hh.

◆ fEpsMaxCmd

G4UIcmdWithADouble* F01FieldMessenger::fEpsMaxCmd = nullptr
private

Definition at line 72 of file F01FieldMessenger.hh.

◆ fUpdateCmd

G4UIcmdWithoutParameter* F01FieldMessenger::fUpdateCmd = nullptr
private

Definition at line 73 of file F01FieldMessenger.hh.

The documentation for this class was generated from the following files:
Generated on Tue Jan 30 2024 12:18:46 for Geant4 examples by   doxygen 1.9.8
Applications | User Support | Publications | Collaboration