QweakSimMagneticField Class Reference

#include <QweakSimMagneticField.hh>

Inherits G4MagneticField.

Collaboration diagram for QweakSimMagneticField:

Public Member Functions
	QweakSimMagneticField ()
	Default constructor. More...
virtual	~QweakSimMagneticField ()
	Virtual destructor. More...
void	GetFieldValue (const G4double point[4], G4double *field) const
	Get the field value. More...
void	PrintFieldValue (const G4double point[4]) const
	Print the field value. More...
void	SetScaleFactor (const double scalefactor)
	Set the scale factor. More...
double	GetScaleFactor () const
	Get the scale factor. More...
void	SetReferenceCurrent (const double referencecurrent)
	Set the reference current. More...
double	GetReferenceCurrent () const
	Get the reference current. More...
void	SetActualCurrent (const double actualcurrent)
	Set the actual current. More...
double	GetActualCurrent () const
	Get the actual current. More...
void	SetRotation (const double rotation)
	Set the field rotation around z. More...
double	GetRotation () const
	Get the field rotation around z. More...
void	SetTranslation (const double translation)
	Set the field translation along z. More...
double	GetTranslation () const
	Get the field translation along z. More...
void	SetTranslationVector (const G4ThreeVector translationvector)
	Set the field translation vector. More...
G4ThreeVector	GetTranslationVector () const
	Get the field translation vector. More...
void	SetMinimum (const double value, const int i)
	Set the minimum. More...
void	SetMaximum (const double value, const int i)
	Set the maximum. More...
void	SetStep (const double value, const int i)
	Set the step. More...
void	SetWrap (const int value, const int i)
	Set the wrap. More...
void	ReadFieldMap (const G4String &filename)
	Read the field map. More...
void	ReadFieldMapText (const G4String &filename)
void	ReadFieldMapBinary (const G4String &filename)
void	TestFieldMap (const G4double point[4], const G4double exact[3]) const
	Test the field map. More...

Private Types
typedef float	value_t
	Field map storage data type. More...

Private Attributes
QweakSimMagneticFieldMessenger *	fMagneticFieldMessenger
	Messenger. More...
QweakSimFieldMap< value_t, value_n > *	fField
double	fRotation
	Field rotation and translation with respect to the z axis. More...
double	fRotationCos
double	fRotationSin
double	fTranslation
G4ThreeVector	fTranslationVector
double	fScaleFactor
	Field map reference and actual currents. More...
double	fActualCurrent
double	fReferenceCurrent
std::vector< double >	fMin
	Field map grid definitions. More...
std::vector< double >	fMax
std::vector< double >	fStep
std::vector< size_t >	fWrap

Static Private Attributes
static const unsigned int	value_n = 3
	Number of field component in the map (x,y,z,r,phi) More...

Detailed Description

Definition at line 24 of file QweakSimMagneticField.hh.

Member Typedef Documentation

typedef float QweakSimMagneticField::value_t

private

Field map storage data type.

Definition at line 32 of file QweakSimMagneticField.hh.

Constructor & Destructor Documentation

QweakSimMagneticField::QweakSimMagneticField

(

)

Default constructor.

Definition at line 48 of file QweakSimMagneticField.cc.

References fActualCurrent, fField, fMagneticFieldMessenger, fMax, fMin, fReferenceCurrent, fScaleFactor, fStep, fWrap, SetRotation(), SetTranslation(), and SetTranslationVector().

{
  G4cout << G4endl << "###### Calling QweakSimMagneticField::QweakSimMagneticField() " << G4endl << G4endl;

  // No field map
  fField = 0;

  // Messenger
  fMagneticFieldMessenger = new QweakSimMagneticFieldMessenger(this);

  // Default settings
  SetRotation(0.0);
  SetTranslation(0.0);
  SetTranslationVector(G4ThreeVector(0.0,0.0,0.0));

  // Default field map grid (peiqing_2007.dat)
  fMin.push_back(-250.0); fMax.push_back(250.0); fStep.push_back(2.0); fWrap.push_back(0);
  fMin.push_back(2.0);    fMax.push_back(300.0); fStep.push_back(2.0); fWrap.push_back(0);
  fMin.push_back(-0.5 * degree/radian); fMax.push_back(360.5 * degree/radian); fStep.push_back(1.0 * degree/radian); fWrap.push_back(2);

  // Set current and scale factors
  G4double current = 8921.0;
  fActualCurrent = current;
  fReferenceCurrent = current;
  fScaleFactor = 1.0;

  G4cout << G4endl << "###### Leaving QweakSimMagneticField::QweakSimMagneticField " << G4endl << G4endl;
}

Here is the call graph for this function:

QweakSimMagneticField::~QweakSimMagneticField ( )

virtual

Virtual destructor.

Definition at line 78 of file QweakSimMagneticField.cc.

References fField, and fMagneticFieldMessenger.

{
  G4cout << G4endl << "###### Calling QweakSimMagneticField::~QweakSimMagneticField() " << G4endl << G4endl;

  // Delete existing magnetic field
  if (fField) delete fField;

  // Delete messenger
  if (fMagneticFieldMessenger) delete fMagneticFieldMessenger;

  G4cout << G4endl << "###### Leaving QweakSimMagneticField::~QweakSimMagneticField() " << G4endl << G4endl;
}

Member Function Documentation

double QweakSimMagneticField::GetActualCurrent ( ) const

inline

Get the actual current.

Definition at line 78 of file QweakSimMagneticField.hh.

References fActualCurrent.

{ return fActualCurrent; };

void QweakSimMagneticField::GetFieldValue	(	const G4double	point[4],
		G4double *	field
	)		const

Get the field value.

Definition at line 262 of file QweakSimMagneticField.cc.

References fField, fScaleFactor, and fTranslationVector.

Referenced by PrintFieldValue(), and TestFieldMap().

{
  // Shift by translation vector
  G4double x = point[0] - fTranslationVector[0];
  G4double y = point[1] - fTranslationVector[1];
  G4double z = point[2] - fTranslationVector[2];

  // Convert from cartesian to cylindrical coordinates
  G4double r   = sqrt(x*x + y*y);
  G4double phi = atan2(y, x);
  if (phi < 0.0) phi += 360.0 * degree;

  // Retrieve field value
  field[0] = 0.0;
  field[1] = 0.0;
  field[2] = 0.0;
  if (fField) {
    // Get field value
    G4double coord[3] = {z/cm, r/cm, phi/radian};
    fField->GetValue(coord,field);

    // Units and scale factor
    field[0] *= fScaleFactor * tesla;
    field[1] *= fScaleFactor * tesla;
    field[2] *= fScaleFactor * tesla;
  }
}

Here is the caller graph for this function:

double QweakSimMagneticField::GetReferenceCurrent ( ) const

inline

Get the reference current.

Definition at line 68 of file QweakSimMagneticField.hh.

References fReferenceCurrent.

{ return fReferenceCurrent; };

double QweakSimMagneticField::GetRotation ( ) const

inline

Get the field rotation around z.

Definition at line 89 of file QweakSimMagneticField.hh.

References fRotation.

{ return fRotation; };

double QweakSimMagneticField::GetScaleFactor ( ) const

inline

Get the scale factor.

Definition at line 58 of file QweakSimMagneticField.hh.

References fScaleFactor.

{ return fScaleFactor; };

double QweakSimMagneticField::GetTranslation ( ) const

inline

Get the field translation along z.

Definition at line 97 of file QweakSimMagneticField.hh.

References fTranslation.

{ return fTranslation; };

G4ThreeVector QweakSimMagneticField::GetTranslationVector ( ) const

inline

Get the field translation vector.

Definition at line 105 of file QweakSimMagneticField.hh.

References fTranslationVector.

{ return fTranslationVector; };

void QweakSimMagneticField::PrintFieldValue

(

const G4double

point[4]

)

const

Print the field value.

Definition at line 243 of file QweakSimMagneticField.cc.

References GetFieldValue().

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

{
  G4double field[3];
  GetFieldValue(point,field);

  // Calculate field value
  G4cout << "Calculating test field value at cartesian position "
    << "(" << point[0]/cm << "," << point[1]/cm << "," << point[2]/cm << ") cm "
    << G4endl;
  G4double value[3] = {0.0, 0.0, 0.0};
  GetFieldValue(point,value);

  // Output
  G4cout << "  Value = "
    << "(" << value[0]/kilogauss << ", " << value[1]/kilogauss << ", " << value[2]/kilogauss << ") kG."
    << G4endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QweakSimMagneticField::ReadFieldMap

(

const G4String &

filename

)

Read the field map.

Definition at line 92 of file QweakSimMagneticField.cc.

References ReadFieldMapBinary(), ReadFieldMapText(), and TestFieldMap().

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

{
  G4cout << G4endl << "###### Calling QweakSimMagneticField::ReadFieldMap() " << G4endl << G4endl;

  // Depending on form of filename, read regular/binary field map
  if (filename.find(".dat") != std::string::npos) {
    ReadFieldMapText(filename);
  }
  if (filename.find(".bin") != std::string::npos) {
    ReadFieldMapBinary(filename);
  }

  // Test new field map
  G4double point1[4] = {100.0 * cm, 0.0 * cm, 100.0 * cm, 0.0};
  G4double exact1[3] = {-0.0499845 * kilogauss, 3.28516 * kilogauss, -0.0112704 * kilogauss};
  TestFieldMap(point1,exact1);
  G4double point2[4] = {0.0 * cm, 100.0 * cm, 100.0 * cm, 0.0};
  G4double exact2[3] = {-3.28505 * kilogauss, -0.0030823 * kilogauss, 0.0014373 * kilogauss};
  TestFieldMap(point2,exact2);
  G4double point3[4] = {100.0 * cm, 100.0 * cm, 100.0 * cm, 0.0};
  G4double exact3[3] = {-0.838069 * kilogauss, 0.836675 * kilogauss, 0.00004997 * kilogauss};
  TestFieldMap(point3,exact3);

  G4cout << G4endl << "###### Leaving QweakSimMagneticField::ReadFieldMap() " << G4endl << G4endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QweakSimMagneticField::ReadFieldMapBinary

(

const G4String &

filename

)

Definition at line 156 of file QweakSimMagneticField.cc.

References fField.

Referenced by ReadFieldMap().

{
  // Delete old field map
  if (fField) delete fField;

  // Create new field map
  fField = new QweakSimFieldMap<value_t,value_n>(filename);
  fField->SetDebugLevel(QweakSimFieldMap<value_t,value_n>::kDebug);

  // Set debug level to something reasonable
  fField->SetDebugLevel(QweakSimFieldMap<value_t,value_n>::kWarning);
}

Here is the caller graph for this function:

void QweakSimMagneticField::ReadFieldMapText

(

const G4String &

filename

)

Definition at line 170 of file QweakSimMagneticField.cc.

References fField, fMax, fMin, fRotation, fRotationCos, fRotationSin, fStep, fTranslation, and fWrap.

Referenced by ReadFieldMap().

{
  // Delete old field map
  if (fField) delete fField;

  // Create new field map
  fField = new QweakSimFieldMap<value_t,value_n>(3);
  fField->SetDebugLevel(QweakSimFieldMap<value_t,value_n>::kDebug);

  // Fill vector of grid min, max, and step size
  fField->SetDimensions(fMin.size());
  fField->SetMinimumMaximumStep(fMin,fMax,fStep);
  fField->SetWrapCoordinate(fWrap);

  // Debug output
  G4cout << "Reading field grid: ";

  // Open the field map file
  std::ifstream inputfile;
  inputfile.open(filename);
  while (inputfile.good()) {
    // Progress bar
    if (fField->GetCurrentEntries() % (fField->GetMaximumEntries() / 10) == 0) {
      int pct = fField->GetCurrentEntries() / (fField->GetMaximumEntries() / 100);
      G4cout << pct << "%" << std::flush;
    }
    if (fField->GetCurrentEntries() % (fField->GetMaximumEntries() / 10) != 0
     && fField->GetCurrentEntries() % (fField->GetMaximumEntries() / 40) == 0) {
      G4cout << "." << std::flush;
    }

    // Read variables
    G4double r = 0.0, z = 0.0, phi = 0.0;
    value_t b[3] = {0.0, 0.0, 0.0};
    inputfile >> r >> z >> phi >> b[0] >> b[1] >> b[2];

    // Transform units into Geant4 system of units
    r *= cm;
    z *= cm;
    phi *= degree;
    b[0] *= kilogauss;
    b[1] *= kilogauss;
    b[2] *= kilogauss;

    // Translation
    z -= fTranslation;

    // Rotation
    phi -= fRotation;
    if (phi <   0.0 * degree) phi += 360.0 * degree;
    if (phi > 360.0 * degree) phi -= 360.0 * degree;
    value_t b_rot[2];
    b_rot[0] =  b[0] * fRotationCos + b[1] * fRotationSin;
    b_rot[1] = -b[0] * fRotationSin + b[1] * fRotationCos;
    b[0] = b_rot[0]; b[1] = b_rot[1];

    // Transform units into fieldmap system of units
    double  coord[3] = { z/cm, r/cm, phi/radian };
    value_t field[3] = { value_t(b[0]/tesla), value_t(b[1]/tesla), value_t(b[2]/tesla) };

    // Store into fieldmap
    fField->Set(coord,field);
  }
  G4cout << G4endl;

  // Close file
  inputfile.close();

  // Set debug level to something reasonable
  fField->SetDebugLevel(QweakSimFieldMap<value_t,value_n>::kWarning);
}

Here is the caller graph for this function:

void QweakSimMagneticField::SetActualCurrent ( const double  actualcurrent )

inline

Set the actual current.

Definition at line 71 of file QweakSimMagneticField.hh.

References fActualCurrent, fReferenceCurrent, and SetScaleFactor().

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

                                                      {
      fActualCurrent = actualcurrent;
      G4cout << "Magnetic field actual current is now: " << fActualCurrent << G4endl;
      if (fReferenceCurrent != 0)
        SetScaleFactor(fActualCurrent/fReferenceCurrent);
    };

Here is the call graph for this function:

Here is the caller graph for this function:

void QweakSimMagneticField::SetMaximum ( const double  value, const int  i  )

inline

Set the maximum.

Definition at line 114 of file QweakSimMagneticField.hh.

References fMax.

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

                                                     {
      fMax.at(i) = value;
      G4cout << "Magnetic field grid max " << i << " is " << fMax.at(i) << " cm/radian" << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::SetMinimum ( const double  value, const int  i  )

inline

Set the minimum.

Definition at line 109 of file QweakSimMagneticField.hh.

References fMin.

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

                                                     {
      fMin.at(i) = value;
      G4cout << "Magnetic field grid min " << i << " is " << fMin.at(i) << " cm/radian" << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::SetReferenceCurrent ( const double  referencecurrent )

inline

Set the reference current.

Definition at line 61 of file QweakSimMagneticField.hh.

References fActualCurrent, fReferenceCurrent, and SetScaleFactor().

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

                                                            {
      fReferenceCurrent = referencecurrent;
      G4cout << "Magnetic field reference current is now: " << fReferenceCurrent << G4endl;
      if (fReferenceCurrent != 0)
        SetScaleFactor(fActualCurrent/fReferenceCurrent);
    };

Here is the call graph for this function:

Here is the caller graph for this function:

void QweakSimMagneticField::SetRotation ( const double  rotation )

inline

Set the field rotation around z.

Definition at line 82 of file QweakSimMagneticField.hh.

References fRotation, fRotationCos, and fRotationSin.

Referenced by QweakSimMagneticField(), and QweakSimMagneticFieldMessenger::SetNewValue().

                                            {
      fRotation = rotation;
      fRotationCos = cos(rotation);
      fRotationSin = sin(rotation);
      G4cout << "Magnetic field rotation is now: " << fRotation/degree << " degree" << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::SetScaleFactor ( const double  scalefactor )

inline

Set the scale factor.

Definition at line 53 of file QweakSimMagneticField.hh.

References fScaleFactor.

Referenced by SetActualCurrent(), QweakSimMagneticFieldMessenger::SetNewValue(), and SetReferenceCurrent().

                                                  {
      fScaleFactor = scalefactor;
      G4cout << "Magnetic field scale factor is now: " << fScaleFactor << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::SetStep ( const double  value, const int  i  )

inline

Set the step.

Definition at line 119 of file QweakSimMagneticField.hh.

References fStep.

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

                                                  {
      fStep.at(i) = value;
      G4cout << "Magnetic field grid step " << i << " is " << fStep.at(i) << " cm/radian" << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::SetTranslation ( const double  translation )

inline

Set the field translation along z.

Definition at line 92 of file QweakSimMagneticField.hh.

References fTranslation.

Referenced by QweakSimMagneticField(), and QweakSimMagneticFieldMessenger::SetNewValue().

                                                  {
      fTranslation = translation;
      G4cout << "Magnetic field translation is now: " << fTranslation/cm << " cm" << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::SetTranslationVector ( const G4ThreeVector  translationvector )

inline

Set the field translation vector.

Definition at line 100 of file QweakSimMagneticField.hh.

References fTranslationVector.

Referenced by QweakSimMagneticField(), and QweakSimMagneticFieldMessenger::SetNewValue().

                                                                     {
      fTranslationVector = translationvector;
      G4cout << "Magnetic field translation is now: " << fTranslationVector/cm << " cm" << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::SetWrap ( const int  value, const int  i  )

inline

Set the wrap.

Definition at line 124 of file QweakSimMagneticField.hh.

References fWrap.

Referenced by QweakSimMagneticFieldMessenger::SetNewValue().

                                               {
      fWrap.at(i) = value;
      G4cout << "Magnetic field grid wrap " << i << " is " << fWrap.at(i) << G4endl;
    };

Here is the caller graph for this function:

void QweakSimMagneticField::TestFieldMap	(	const G4double	point[4],
		const G4double	exact[3]
	)		const

Test the field map.

Definition at line 119 of file QweakSimMagneticField.cc.

References GetFieldValue().

Referenced by ReadFieldMap().

{
  // Calculate field value
  G4cout << "Calculating test field value at cartesian position "
    << "(" << point[0]/cm << "," << point[1]/cm << "," << point[2]/cm << ") cm "
    << G4endl;
  G4double value[3] = {0.0, 0.0, 0.0};
  GetFieldValue(point,value);

  // Calculate difference
  G4double diff[3] = {0.0, 0.0, 0.0};
  G4double norm = 0.0;
  for (size_t i = 0; i < 3; i++) {
    diff[i] = value[i] - exact[i];
    norm += diff[i] * diff[i];
  }
  norm = sqrt(norm);

  // Output
  G4cout << "  Value = "
    << "(" << value[0]/kilogauss << ", " << value[1]/kilogauss << ", " << value[2]/kilogauss << ") kG."
    << G4endl;
  G4cout << "  Exact = "
    << "(" << exact[0]/kilogauss << ", " << exact[1]/kilogauss << ", " << exact[2]/kilogauss << ") kG."
    << G4endl;
  G4cout << "  Diff  = "
    << "(" << diff[0]/kilogauss << ", " << diff[1]/kilogauss << ", " << diff[2]/kilogauss << ") kG."
    << G4endl;

  // Test difference (0.1 kilogauss is of the order of 2%)
  if (norm > 0.1 * kilogauss) {
    G4cerr << "Magnetic field is different from expected value by " << norm/kilogauss << " kG."
           << G4endl;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

double QweakSimMagneticField::fActualCurrent

private

Definition at line 153 of file QweakSimMagneticField.hh.

Referenced by GetActualCurrent(), QweakSimMagneticField(), SetActualCurrent(), and SetReferenceCurrent().

QweakSimFieldMap<value_t,value_n>* QweakSimMagneticField::fField

private

Definition at line 140 of file QweakSimMagneticField.hh.

Referenced by GetFieldValue(), QweakSimMagneticField(), ReadFieldMapBinary(), ReadFieldMapText(), and ~QweakSimMagneticField().

QweakSimMagneticFieldMessenger* QweakSimMagneticField::fMagneticFieldMessenger

private

Messenger.

Definition at line 35 of file QweakSimMagneticField.hh.

Referenced by QweakSimMagneticField(), and ~QweakSimMagneticField().

std::vector<double> QweakSimMagneticField::fMax

private

Definition at line 157 of file QweakSimMagneticField.hh.

Referenced by QweakSimMagneticField(), ReadFieldMapText(), and SetMaximum().

std::vector<double> QweakSimMagneticField::fMin

private

Field map grid definitions.

Definition at line 157 of file QweakSimMagneticField.hh.

Referenced by QweakSimMagneticField(), ReadFieldMapText(), and SetMinimum().

double QweakSimMagneticField::fReferenceCurrent

private

Definition at line 154 of file QweakSimMagneticField.hh.

Referenced by GetReferenceCurrent(), QweakSimMagneticField(), SetActualCurrent(), and SetReferenceCurrent().

double QweakSimMagneticField::fRotation

private

Field rotation and translation with respect to the z axis.

Definition at line 147 of file QweakSimMagneticField.hh.

Referenced by GetRotation(), ReadFieldMapText(), and SetRotation().

double QweakSimMagneticField::fRotationCos

private

Definition at line 147 of file QweakSimMagneticField.hh.

Referenced by ReadFieldMapText(), and SetRotation().

double QweakSimMagneticField::fRotationSin

private

Definition at line 147 of file QweakSimMagneticField.hh.

Referenced by ReadFieldMapText(), and SetRotation().

double QweakSimMagneticField::fScaleFactor

private

Field map reference and actual currents.

Definition at line 152 of file QweakSimMagneticField.hh.

Referenced by GetFieldValue(), GetScaleFactor(), QweakSimMagneticField(), and SetScaleFactor().

std::vector<double> QweakSimMagneticField::fStep

private

Definition at line 157 of file QweakSimMagneticField.hh.

Referenced by QweakSimMagneticField(), ReadFieldMapText(), and SetStep().

double QweakSimMagneticField::fTranslation

private

Definition at line 148 of file QweakSimMagneticField.hh.

Referenced by GetTranslation(), ReadFieldMapText(), and SetTranslation().

G4ThreeVector QweakSimMagneticField::fTranslationVector

private

Definition at line 149 of file QweakSimMagneticField.hh.

Referenced by GetFieldValue(), GetTranslationVector(), and SetTranslationVector().

std::vector<size_t> QweakSimMagneticField::fWrap

private

Definition at line 158 of file QweakSimMagneticField.hh.

Referenced by QweakSimMagneticField(), ReadFieldMapText(), and SetWrap().

const unsigned int QweakSimMagneticField::value_n = 3

staticprivate

Number of field component in the map (x,y,z,r,phi)

Definition at line 29 of file QweakSimMagneticField.hh.

---

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

• QweakSimMagneticField.hh
• QweakSimMagneticField.cc