#include <F04SimpleSolenoid.hh>
Inheritance diagram for F04SimpleSolenoid: Collaboration diagram for F04SimpleSolenoid:Public Member Functions | |
| F04SimpleSolenoid (G4double, G4double, G4LogicalVolume *, G4ThreeVector) | |
| Default constructor. More... | |
| virtual | ~F04SimpleSolenoid () |
| Destructor. More... | |
| virtual G4double | GetLength () |
| GetLength() returns the length of the solenoid. More... | |
| virtual G4double | GetWidth () |
| GetWidth() returns the solenoid diameter. More... | |
| virtual G4double | GetHeight () |
| GetHeight() returns the solenoid diameter. More... | |
| void | SetFringeZ (G4double z) |
| SetFringeZ(G4double) sets the solenoid fringe field z-length. More... | |
| G4double | GetFringeZ () |
| GetFringeZ() returns the solenoid fringe field z-length. More... | |
| G4bool | IsOutside (G4ThreeVector &local) const |
| IsOutside() returns true when outside the solenoid. More... | |
| G4bool | IsWithin (G4ThreeVector &local) const |
| IsWithin() returns true when inside the solenoid. More... | |
| virtual void | AddFieldValue (const G4double point[4], G4double field[6]) const |
| AddFieldValue() adds the field for this solenoid into field[]. point[] is in global coordinates. More... | |
| Public Member Functions inherited from F04ElementField | |
| F04ElementField (const G4ThreeVector, G4LogicalVolume *) | |
| Constructor. More... | |
| void | Construct () |
| the actual implementation constructs the F04ElementField More... | |
| virtual | ~F04ElementField () |
| Destructor. More... | |
| void | SetMaxStep (G4double stp) |
| SetMaxStep(G4double) sets the max. step size. More... | |
| G4double | GetMaxStep () |
| GetMaxStep() returns the max. step size. More... | |
| void | SetColor (G4String c) |
| SetColor(G4String) sets the color. More... | |
| G4String | GetColor () |
| GetColor() returns the color. More... | |
| void | SetGlobalPoint (const G4double point[4]) |
| SetGlobalPoint() ensures that the point is within the global bounding box of this ElementField's global coordinates. Normally called 8 times for the corners of the local bounding box, after a local->global coordinate transform. If never called, the global bounding box is infinite. BEWARE: if called only once, the bounding box is just a point. More... | |
| bool | IsInBoundingBox (const G4double point[4]) const |
| IsInBoundingBox() returns true if the point is within the global bounding box - global coordinates. More... | |
Private Attributes | |
| G4double | fBfield |
| G4double | fFringeZ |
| G4double | fFieldLength |
| G4double | fFieldRadius |
Additional Inherited Members | |
| Static Public Member Functions inherited from F04ElementField | |
| static G4VisAttributes * | GetVisAttribute (G4String color) |
| GetVisAttribute() returns the appropriate G4VisAttributes. More... | |
| Protected Attributes inherited from F04ElementField | |
| G4LogicalVolume * | fVolume |
| G4AffineTransform | fGlobal2local |
Detailed Description
Definition at line 44 of file F04SimpleSolenoid.hh.
Constructor & Destructor Documentation
| F04SimpleSolenoid::F04SimpleSolenoid | ( | G4double | Bz, |
| G4double | fz, | ||
| G4LogicalVolume * | lv, | ||
| G4ThreeVector | c | ||
| ) |
Default constructor.
Definition at line 42 of file F04SimpleSolenoid.cc.
References fBfield, fFieldLength, fFieldRadius, fFringeZ, F04ElementField::fVolume, and G4LogicalVolume::GetSolid().
Here is the call graph for this function:
|
inlinevirtual |
Destructor.
Definition at line 52 of file F04SimpleSolenoid.hh.
Member Function Documentation
AddFieldValue() adds the field for this solenoid into field[]. point[] is in global coordinates.
Implements F04ElementField.
Reimplemented in F04FocusSolenoid.
Definition at line 55 of file F04SimpleSolenoid.cc.
References fBfield, F04ElementField::fGlobal2local, G4AffineTransform::Inverse(), IsOutside(), local, G4AffineTransform::TransformAxis(), and G4AffineTransform::TransformPoint().
Here is the call graph for this function:
|
inline |
GetFringeZ() returns the solenoid fringe field z-length.
Definition at line 67 of file F04SimpleSolenoid.hh.
References fFringeZ.
|
inlinevirtual |
GetHeight() returns the solenoid diameter.
Implements F04ElementField.
Definition at line 61 of file F04SimpleSolenoid.hh.
References fFieldRadius.
|
inlinevirtual |
GetLength() returns the length of the solenoid.
Implements F04ElementField.
Definition at line 55 of file F04SimpleSolenoid.hh.
References fFieldLength.
|
inlinevirtual |
GetWidth() returns the solenoid diameter.
Implements F04ElementField.
Definition at line 58 of file F04SimpleSolenoid.hh.
References fFieldRadius.
| G4bool F04SimpleSolenoid::IsOutside | ( | G4ThreeVector & | local | ) | const |
IsOutside() returns true when outside the solenoid.
Definition at line 76 of file F04SimpleSolenoid.cc.
References fFieldLength, and fFieldRadius.
Referenced by F04FocusSolenoid::AddFieldValue(), and AddFieldValue().
Here is the caller graph for this function:| G4bool F04SimpleSolenoid::IsWithin | ( | G4ThreeVector & | local | ) | const |
IsWithin() returns true when inside the solenoid.
Definition at line 86 of file F04SimpleSolenoid.cc.
References fFieldLength, and fFieldRadius.
|
inline |
SetFringeZ(G4double) sets the solenoid fringe field z-length.
Definition at line 64 of file F04SimpleSolenoid.hh.
Member Data Documentation
|
private |
Definition at line 81 of file F04SimpleSolenoid.hh.
Referenced by AddFieldValue(), and F04SimpleSolenoid().
|
private |
Definition at line 85 of file F04SimpleSolenoid.hh.
Referenced by F04SimpleSolenoid(), GetLength(), IsOutside(), and IsWithin().
|
private |
Definition at line 86 of file F04SimpleSolenoid.hh.
Referenced by F04SimpleSolenoid(), GetHeight(), GetWidth(), IsOutside(), and IsWithin().
|
private |
Definition at line 83 of file F04SimpleSolenoid.hh.
Referenced by F04SimpleSolenoid(), GetFringeZ(), and SetFringeZ().
The documentation for this class was generated from the following files:
- geant4.10.00.p01/examples/extended/field/field04/include/F04SimpleSolenoid.hh
- geant4.10.00.p01/examples/extended/field/field04/src/F04SimpleSolenoid.cc
