F04ElementField Class Reference

#include <Doxymodules_field.h>

Inheritance diagram for F04ElementField:

Public Member Functions
	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.
virtual void	AddFieldValue (const G4double point[4], G4double field[6]) const =0
	AddFieldValue() will add the field value for this element to field[].
virtual G4double	GetLength ()=0
virtual G4double	GetWidth ()=0
virtual G4double	GetHeight ()=0

Static Public Member Functions
static G4VisAttributes *	GetVisAttribute (G4String color)
	GetVisAttribute() returns the appropriate G4VisAttributes.

Protected Attributes
G4LogicalVolume *	fVolume = nullptr
G4AffineTransform	fGlobal2local

Private Member Functions
F04ElementField &	operator= (const F04ElementField &)

Private Attributes
G4String	fColor = "1,1,1"
G4ThreeVector	fCenter
G4double	fMinX = -DBL_MAX
G4double	fMinY = -DBL_MAX
G4double	fMinZ = -DBL_MAX
G4double	fMaxX = DBL_MAX
G4double	fMaxY = DBL_MAX
G4double	fMaxZ = DBL_MAX
G4double	fMaxStep = 1. * CLHEP::mm
G4UserLimits *	fUserLimits = nullptr

Static Private Attributes
static G4ThreadLocal G4Navigator *	fNavigator = nullptr

Detailed Description

Definition at line 101 of file Doxymodules_field.h.

Constructor & Destructor Documentation

F04ElementField()

F04ElementField::F04ElementField	(	const G4ThreeVector	c,
		G4LogicalVolume *	lv
	)

Constructor.

Definition at line 43 of file F04ElementField.cc.

 : fVolume(lv),
   fCenter(c)
{
  F04GlobalField::GetObject()->AddElementField(this);
 
  fUserLimits = new G4UserLimits();
  fUserLimits->SetMaxAllowedStep(fMaxStep);
  fUserLimits->SetUserMaxTrackLength(500.*m);
  fUserLimits->SetUserMaxTime(10*ms);
  fUserLimits->SetUserMinEkine(0.1*MeV);
//  fUserLimits->SetUserMinRange(1*mm);
 
  fVolume->SetVisAttributes(GetVisAttribute(fColor));
  fVolume->SetUserLimits(fUserLimits);
}

~F04ElementField()

virtual F04ElementField::~F04ElementField ( )

virtualdefault

Destructor.

Member Function Documentation

Construct()

void F04ElementField::Construct

(

)

the actual implementation constructs the F04ElementField

Definition at line 62 of file F04ElementField.cc.

{
  G4Navigator* theNavigator =
                    G4TransportationManager::GetTransportationManager()->
                                                 GetNavigatorForTracking();
  if (!fNavigator) {
     fNavigator = new G4Navigator();
     if ( theNavigator->GetWorldVolume() )
               fNavigator->SetWorldVolume(theNavigator->GetWorldVolume());
   }
 
  fNavigator->LocateGlobalPointAndSetup(fCenter,nullptr,false);
 
  G4TouchableHandle touchable = fNavigator->CreateTouchableHistoryHandle();
 
  G4int depth = touchable->GetHistoryDepth();
  for (G4int i = 0; i<depth; ++i) {
      if(touchable->GetVolume()->GetLogicalVolume() == fVolume)break;
      touchable->MoveUpHistory();
  }
 
  // set fGlobal2local transform
  fGlobal2local = touchable->GetHistory()->GetTopTransform();
 
  // set global bounding box
  G4double local[4], global[4];
 
  G4ThreeVector globalPosition;
  local[3] = 0.0;
  for (G4int i=0; i<2; ++i) {
      local[0] = (i==0 ? -1.0 : 1.0) * GetWidth()/2.;
      for (G4int j=0; j<2; ++j) {
          local[1] = (j==0 ? -1.0 : 1.0) * GetHeight()/2.;
          for (G4int k=0; k<2; ++k) {
              local[2] = (k==0 ? -1.0 : 1.0) * GetLength()/2.;
              G4ThreeVector localPosition(local[0],local[1],local[2]);
              globalPosition =
                         fGlobal2local.Inverse().TransformPoint(localPosition);
              global[0] = globalPosition.x();
              global[1] = globalPosition.y();
              global[2] = globalPosition.z();
              SetGlobalPoint(global);
           }
      }
  }
}

SetMaxStep()

void F04ElementField::SetMaxStep ( G4double  stp )

inline

SetMaxStep(G4double) sets the max. step size.

Definition at line 69 of file F04ElementField.hh.

    {
      fMaxStep = stp;
      fUserLimits->SetMaxAllowedStep(fMaxStep);
      fVolume->SetUserLimits(fUserLimits);
    }

GetMaxStep()

G4double F04ElementField::GetMaxStep ( )

inline

GetMaxStep() returns the max. step size.

Definition at line 77 of file F04ElementField.hh.

{ return fMaxStep; }

SetColor()

void F04ElementField::SetColor ( G4String  c )

inline

SetColor(G4String) sets the color.

Definition at line 80 of file F04ElementField.hh.

    {
      fColor = c;
      fVolume->SetVisAttributes(GetVisAttribute(fColor));
    }

GetColor()

G4String F04ElementField::GetColor ( )

inline

GetColor() returns the color.

Definition at line 87 of file F04ElementField.hh.

{ return fColor; }

GetVisAttribute()

G4VisAttributes * F04ElementField::GetVisAttribute ( G4String  color )

static

GetVisAttribute() returns the appropriate G4VisAttributes.

Definition at line 111 of file F04ElementField.cc.

{
   G4VisAttributes* p = nullptr;
   if(color.size() > 0 &&
     (isdigit(color.c_str()[0]) || color.c_str()[0] == '.')) {
        G4double red=0.0, green=0.0, blue=0.0;
        if (sscanf(color.c_str(),"%lf,%lf,%lf",&red,&green,&blue) == 3) {
           p = new G4VisAttributes(true,G4Color(red,green,blue));
        } else {
           G4cout << " Invalid color " << color << G4endl;
        }
   }
 
   if (!p) p = new G4VisAttributes(G4VisAttributes::GetInvisible());
   p->SetDaughtersInvisible(false);
 
   return p;
}

SetGlobalPoint()

void F04ElementField::SetGlobalPoint ( const G4double  point[4] )

inline

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.

Definition at line 98 of file F04ElementField.hh.

    {
      if(fMinX == -DBL_MAX || fMinX > point[0]) fMinX = point[0];
      if(fMinY == -DBL_MAX || fMinY > point[1]) fMinY = point[1];
      if(fMinZ == -DBL_MAX || fMinZ > point[2]) fMinZ = point[2];
      if(fMaxX ==  DBL_MAX || fMaxX < point[0]) fMaxX = point[0];
      if(fMaxY ==  DBL_MAX || fMaxY < point[1]) fMaxY = point[1];
      if(fMaxZ ==  DBL_MAX || fMaxZ < point[2]) fMaxZ = point[2];
    }

IsInBoundingBox()

bool F04ElementField::IsInBoundingBox ( const G4double  point[4] ) const

inline

IsInBoundingBox() returns true if the point is within the global bounding box - global coordinates.

Definition at line 110 of file F04ElementField.hh.

    {
      if(point[2] < fMinZ || point[2] > fMaxZ) return false;
      if(point[0] < fMinX || point[0] > fMaxX) return false;
      if(point[1] < fMinY || point[1] > fMaxY) return false;
      return true;
    }

AddFieldValue()

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

pure virtual

AddFieldValue() will add the field value for this element to field[].

Implementations must be sure to verify that point[] is within the field region, and do nothing if not. point[] is in global coordinates and geant4 units; x,y,z,t. field[] is in geant4 units; Bx,By,Bz,Ex,Ey,Ez. For efficiency, the caller may (but need not) call IsInBoundingBox(point), and only call this function if that returns true.

Implemented in F04FocusSolenoid, and F04SimpleSolenoid.

GetLength()

virtual G4double F04ElementField::GetLength ( )

pure virtual

Implemented in F04SimpleSolenoid.

GetWidth()

virtual G4double F04ElementField::GetWidth ( )

pure virtual

Implemented in F04SimpleSolenoid.

GetHeight()

virtual G4double F04ElementField::GetHeight ( )

pure virtual

Implemented in F04SimpleSolenoid.

operator=()

F04ElementField & F04ElementField::operator= ( const F04ElementField &  )

private

Member Data Documentation

fVolume

G4LogicalVolume* F04ElementField::fVolume = nullptr

protected

Definition at line 135 of file F04ElementField.hh.

fGlobal2local

G4AffineTransform F04ElementField::fGlobal2local

protected

Definition at line 137 of file F04ElementField.hh.

fNavigator

G4ThreadLocal G4Navigator * F04ElementField::fNavigator = nullptr

staticprivate

Definition at line 144 of file F04ElementField.hh.

fColor

G4String F04ElementField::fColor = "1,1,1"

private

Definition at line 146 of file F04ElementField.hh.

fCenter

G4ThreeVector F04ElementField::fCenter

private

Definition at line 148 of file F04ElementField.hh.

fMinX

G4double F04ElementField::fMinX = -DBL_MAX

private

Definition at line 149 of file F04ElementField.hh.

fMinY

G4double F04ElementField::fMinY = -DBL_MAX

private

Definition at line 150 of file F04ElementField.hh.

fMinZ

G4double F04ElementField::fMinZ = -DBL_MAX

private

Definition at line 151 of file F04ElementField.hh.

fMaxX

G4double F04ElementField::fMaxX = DBL_MAX

private

Definition at line 152 of file F04ElementField.hh.

fMaxY

G4double F04ElementField::fMaxY = DBL_MAX

private

Definition at line 153 of file F04ElementField.hh.

fMaxZ

G4double F04ElementField::fMaxZ = DBL_MAX

private

Definition at line 154 of file F04ElementField.hh.

fMaxStep

G4double F04ElementField::fMaxStep = 1. * CLHEP::mm

private

Definition at line 156 of file F04ElementField.hh.

fUserLimits

G4UserLimits* F04ElementField::fUserLimits = nullptr

private

Definition at line 157 of file F04ElementField.hh.

---

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

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