F04FocusSolenoid Class Reference

#include <Doxymodules_field.h>

Inheritance diagram for F04FocusSolenoid:

Public Member Functions
	F04FocusSolenoid (G4double, G4double, G4double, G4LogicalVolume *, G4ThreeVector)
	Default constructor.
	~F04FocusSolenoid () override=default
	Destructor.
void	SetHalf (G4bool h)
	Set F04FocusSolenoid to only half-focusing (default negative z)
void	AddFieldValue (const G4double point[4], G4double field[6]) const override
	AddFieldValue() adds the field for this solenoid into field[].
Public Member Functions inherited from F04SimpleSolenoid
	F04SimpleSolenoid (G4double, G4double, G4LogicalVolume *, G4ThreeVector)
	Default constructor.
	~F04SimpleSolenoid () override=default
	Destructor.
G4double	GetLength () override
	GetLength() returns the length of the solenoid.
G4double	GetWidth () override
	GetWidth() returns the solenoid diameter.
G4double	GetHeight () override
	GetHeight() returns the solenoid diameter.
void	SetFringeZ (G4double z)
	SetFringeZ(G4double) sets the solenoid fringe field z-length.
G4double	GetFringeZ ()
	GetFringeZ() returns the solenoid fringe field z-length.
G4bool	IsOutside (G4ThreeVector &local) const
	IsOutside() returns true when outside the solenoid.
G4bool	IsWithin (G4ThreeVector &local) const
	IsWithin() returns true when inside the solenoid.
void	AddFieldValue (const G4double point[4], G4double field[6]) const override
	AddFieldValue() adds the field for this solenoid into field[].
Public Member Functions inherited from F04ElementField
	F04ElementField (const G4ThreeVector, G4LogicalVolume *)
	Constructor.
void	Construct ()
	the actual implementation constructs the F04ElementField
virtual	~F04ElementField ()=default
	Destructor.
void	SetMaxStep (G4double stp)
	SetMaxStep(G4double) sets the max. step size.
G4double	GetMaxStep ()
	GetMaxStep() returns the max. step size.
void	SetColor (G4String c)
	SetColor(G4String) sets the color.
G4String	GetColor ()
	GetColor() returns the color.
void	SetGlobalPoint (const G4double point[4])
	SetGlobalPoint() ensures that the point is within the global bounding box of this ElementField's global coordinates.
bool	IsInBoundingBox (const G4double point[4]) const
	IsInBoundingBox() returns true if the point is within the global bounding box - global coordinates.

Private Attributes
G4bool	fHalf = false
G4double	fB1 = 0.
G4double	fB2 = 0.

Additional Inherited Members
Static Public Member Functions inherited from F04ElementField
static G4VisAttributes *	GetVisAttribute (G4String color)
	GetVisAttribute() returns the appropriate G4VisAttributes.
Protected Attributes inherited from F04ElementField
G4LogicalVolume *	fVolume = nullptr
G4AffineTransform	fGlobal2local

Detailed Description

Definition at line 106 of file Doxymodules_field.h.

Constructor & Destructor Documentation

F04FocusSolenoid()

F04FocusSolenoid::F04FocusSolenoid	(	G4double	Ba,
		G4double	Bb,
		G4double	fz,
		G4LogicalVolume *	lv,
		G4ThreeVector	c
	)

Default constructor.

Definition at line 42 of file F04FocusSolenoid.cc.

 : F04SimpleSolenoid(Ba, fz, lv, c),
   fB1(Ba),
   fB2(Bb)
{}

~F04FocusSolenoid()

F04FocusSolenoid::~F04FocusSolenoid ( )

overridedefault

Destructor.

Member Function Documentation

SetHalf()

void F04FocusSolenoid::SetHalf ( G4bool  h )

inline

Set F04FocusSolenoid to only half-focusing (default negative z)

Definition at line 53 of file F04FocusSolenoid.hh.

{ fHalf = h; }

AddFieldValue()

void F04FocusSolenoid::AddFieldValue ( const G4double  point[4], G4double  field[6]  ) const

overridevirtual

AddFieldValue() adds the field for this solenoid into field[].

point[] is in global coordinates.

Implements F04ElementField.

Definition at line 52 of file F04FocusSolenoid.cc.

{
   G4ThreeVector global(point[0],point[1],point[2]);
 
   G4ThreeVector local = fGlobal2local.TransformPoint(global);
 
   if (IsOutside(local)) return;
 
   G4double length = ((F04SimpleSolenoid*)this)->GetLength();
 
   G4double Bz = (fB2-fB1) * std::abs(local.z())/(length/2.) + fB1;
 
   if (fHalf) { if (local.z() >= 0.) Bz = fB1; }
 
   G4ThreeVector B(0.0,0.0,Bz);
 
   B = fGlobal2local.Inverse().TransformAxis(B);
 
   field[0] += B[0];
   field[1] += B[1];
   field[2] += B[2];
}

Member Data Documentation

fHalf

G4bool F04FocusSolenoid::fHalf = false

private

Definition at line 61 of file F04FocusSolenoid.hh.

fB1

G4double F04FocusSolenoid::fB1 = 0.

private

Definition at line 63 of file F04FocusSolenoid.hh.

fB2

G4double F04FocusSolenoid::fB2 = 0.

private

Definition at line 64 of file F04FocusSolenoid.hh.

---

The documentation for this class was generated from the following files:

• .doxygen/Doxymodules_field.h
• extended/field/field04/include/F04FocusSolenoid.hh
• extended/field/field04/src/F04FocusSolenoid.cc