F04SimpleSolenoid Class Reference

#include <Doxymodules_field.h>

Inheritance diagram for F04SimpleSolenoid:

Public Member Functions
	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
G4double	fBfield = 0.
G4double	fFringeZ = 0.
G4double	fFieldLength = 0.
G4double	fFieldRadius = 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 116 of file Doxymodules_field.h.

Constructor & Destructor Documentation

F04SimpleSolenoid()

F04SimpleSolenoid::F04SimpleSolenoid	(	G4double	Bz,
		G4double	fz,
		G4LogicalVolume *	lv,
		G4ThreeVector	c
	)

Default constructor.

Definition at line 41 of file F04SimpleSolenoid.cc.

 : F04ElementField(c,lv),
   fBfield(Bz),
   fFringeZ(fz),
   fFieldLength(2.*((G4Tubs*)fVolume->GetSolid())->GetZHalfLength()+fFringeZ),
   fFieldRadius(((G4Tubs*)fVolume->GetSolid())->GetOuterRadius())
{}

~F04SimpleSolenoid()

F04SimpleSolenoid::~F04SimpleSolenoid ( )

overridedefault

Destructor.

Member Function Documentation

GetLength()

G4double F04SimpleSolenoid::GetLength ( )

inlineoverridevirtual

GetLength() returns the length of the solenoid.

Implements F04ElementField.

Definition at line 54 of file F04SimpleSolenoid.hh.

{ return fFieldLength; }

GetWidth()

G4double F04SimpleSolenoid::GetWidth ( )

inlineoverridevirtual

GetWidth() returns the solenoid diameter.

Implements F04ElementField.

Definition at line 57 of file F04SimpleSolenoid.hh.

{ return fFieldRadius*2.0; }

GetHeight()

G4double F04SimpleSolenoid::GetHeight ( )

inlineoverridevirtual

GetHeight() returns the solenoid diameter.

Implements F04ElementField.

Definition at line 60 of file F04SimpleSolenoid.hh.

{ return fFieldRadius*2.0; }

SetFringeZ()

void F04SimpleSolenoid::SetFringeZ ( G4double  z )

inline

SetFringeZ(G4double) sets the solenoid fringe field z-length.

Definition at line 63 of file F04SimpleSolenoid.hh.

{ fFringeZ = z; }

GetFringeZ()

G4double F04SimpleSolenoid::GetFringeZ ( )

inline

GetFringeZ() returns the solenoid fringe field z-length.

Definition at line 66 of file F04SimpleSolenoid.hh.

{ return fFringeZ; }

IsOutside()

G4bool F04SimpleSolenoid::IsOutside

(

G4ThreeVector &

local

)

const

IsOutside() returns true when outside the solenoid.

Definition at line 74 of file F04SimpleSolenoid.cc.

{
//  EInside inside = tubs->Inside(local);
//  return (inside == kOutside);
  G4double r = std::sqrt(local.x()*local.x()+local.y()*local.y());
  return (r > fFieldRadius || std::fabs(local.z()) > fFieldLength/2.0);
}

IsWithin()

G4bool F04SimpleSolenoid::IsWithin

(

G4ThreeVector &

local

)

const

IsWithin() returns true when inside the solenoid.

Definition at line 84 of file F04SimpleSolenoid.cc.

{
//  EInside inside = tubs->Inside(local);
//  return (inside == kInside);
  G4double r = std::sqrt(local.x()*local.x()+local.y()*local.y());
  return (r < fFieldRadius && std::fabs(local.z()) < fFieldLength/2.0);
}

AddFieldValue()

void F04SimpleSolenoid::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 53 of file F04SimpleSolenoid.cc.

{
   G4ThreeVector global(point[0],point[1],point[2]);
   G4ThreeVector local;
 
   local = fGlobal2local.TransformPoint(global);
 
   if (IsOutside(local)) return;
 
   G4ThreeVector B(0.0,0.0,fBfield);
 
   B = fGlobal2local.Inverse().TransformAxis(B);
 
   field[0] += B[0];
   field[1] += B[1];
   field[2] += B[2];
}

Member Data Documentation

fBfield

G4double F04SimpleSolenoid::fBfield = 0.

private

Definition at line 80 of file F04SimpleSolenoid.hh.

fFringeZ

G4double F04SimpleSolenoid::fFringeZ = 0.

private

Definition at line 82 of file F04SimpleSolenoid.hh.

fFieldLength

G4double F04SimpleSolenoid::fFieldLength = 0.

private

Definition at line 84 of file F04SimpleSolenoid.hh.

fFieldRadius

G4double F04SimpleSolenoid::fFieldRadius = 0.

private

Definition at line 85 of file F04SimpleSolenoid.hh.

---

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

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